Implement VotingStreakMultiplier #129

secbajor · 2025-04-24T17:05:23Z

When a vote is cast (via the YieldDistributor), the VotingStreakMultiplier updates it's state variables tracking user's multiplier value and validity.

When this contract is deployed, the front end can call getMultiplyingFactor for the user's current multiplier.

[#127]

src/YieldDistributor.sol

bagelface

needs slight redesign

src/YieldDistributor.sol

src/multipliers/VotingStreakMultiplier.sol

RonTuretzky

pattern is implemented as expected! looking very elegant!

src/interfaces/multipliers/IMultiplier.sol

src/multipliers/VotingStreakMultiplier.sol

secbajor · 2025-05-08T00:18:38Z

@bagelface @RonTuretzky with my latest commit here, the build is compiling without errors/warnings and the tests all pass. Can you advise on next steps?

RonTuretzky

LGTM so far , please add a VotingStreakMultiplier.t.sol file with unit tests

src/multipliers/VotingStreakMultiplier.sol

src/interfaces/multipliers/INFTMultiplier.sol

src/multipliers/VotingStreakMultiplier.sol

bagelface · 2025-05-30T15:42:58Z

test/YieldDistributor.t.sol

@@ -451,6 +454,190 @@ contract YieldDistributorTest is Test {
    }
 }

+contract VotingStreakMultiplierTest is YieldDistributorTest {
+    // uint256 constant START = 32_323_232_323;
+    uint256 constant MULTIPLIER_INCREMENT = 0.02e20;


what's up with this number?

test/YieldDistributor.t.sol

bagelface

have a few readability and style comments, but nothing that would prevent this from being merged in. Great stuff!

…hould be set to fixed point notation small percentages

bagelface · 2025-06-02T19:51:29Z

src/VotingMultipliers.sol

@@ -71,8 +80,8 @@ contract VotingMultipliers is Ownable2StepUpgradeable, IVotingMultipliers {
    /// @param _user The address of the user
    /// @param _multiplierIndexes Array of multiplier indexes to use
    /// @return The total multiplier value for the user
-    function getTotalMultipliers(address _user, uint256[] calldata _multiplierIndexes) public view returns (uint256) {
-        uint256 _totalMultiplier = 0;
+    function getTotalMultipliers(address _user, uint256[] calldata _multiplierIndexes) public returns (uint256) {


get functions should have the view visibility. this won't be very useful on the frontend as is. i would remove updateMultiplyingFactor to allow this to be view. then just tolerate that it might be out of sync on the frontend. maybe add a "isSynced" flag based on timestamps and cycle length that can be checked and return alongside the multiplier value?

@bagelface this function gets called from the yielddistributor, but the following function of the same name has a @dev notice that its intended to be called from front end, and is a view function.

so my sense is this should remain as is, but please clarify if you see it differently.

My issue with this change is mostly from a readability perspective. The function name is getTotalMultipliers but it is not a view function, which is inconsistent. The visibility should either be updated or the name of the function should change so that it's clear that state changes are being made when it's called.

src/interfaces/multipliers/IDynamicNFTMultiplier.sol

src/multipliers/VotingStreakMultiplier.sol

bagelface · 2025-06-05T15:36:34Z

src/multipliers/VotingStreakMultiplier.sol

+/// @dev Implements IMultiplier and IVotingStreakMultiplier interfaces
+contract VotingStreakMultiplier is Initializable, OwnableUpgradeable, IMultiplier {
+    /// @notice The base multiplier value (100% in fixed-point representation)
+    uint256 constant BASE_MULTIPLIER = 1e18;


usually good to be explicit with accessibility. this will default to private

bagelface · 2025-06-05T15:39:56Z

src/interfaces/multipliers/IMultiplier.sol

@@ -2,7 +2,11 @@
 pragma solidity ^0.8.0;

 interface IMultiplier {


I actually might be a good idea to just add BASE_MULTIPLIER constant here

i had this instinct as well, but found that solidity prevents variables from being set in interfaces. cursor suggested i create a library directory and define it, like MultiplierConstants, and import it from there. Do you think that's a good solution ?

did this in a separate commit so its clearer f17990d - wdyt?

oh weird I didnt know that. I do think this makes things a little easier to work with so that the value doesn't need to be explicitly defined each time

bagelface · 2025-06-05T15:47:43Z

test/YieldDistributor.t.sol

+        // Expected voting power = initial * boost
+        // Start with base 100% (1e18) and add only the bonus amounts
+        uint256 totalMultiplier = 1e18; // Base 100%
+        totalMultiplier += (1.5e18 - 1e18) + (2e18 - 1e18); // Add bonuses from both multipliers


just heads up, you can use the ether keyword to represent this like:

totalMultiplier += (1.5 ether - 1 ether) + (2 ether - 1 ether);

im going to choose to leave it like 1e18 only because i think thats a little more self explanatory than ether, and i havent gotten the sense you have a strong preference

good to know tho, appreciate the tip!!

bagelface

a few comments, but lgtm

Ron Turetzky and others added 5 commits March 19, 2025 12:17

Add Voting streak multiplier contract

526986a

[#127]

Make VotingStreakMultiplier an IMultiplier

9e57b1b

Update YieldDistributor to call voting streak multiplier onVoteCase

0ee81a2

check if the multiplier is valid

7f56c11

update comment

e74b804

secbajor changed the title ~~Sb 127 2~~ Implement VotingStreakMultiplier Apr 24, 2025

secbajor mentioned this pull request Apr 24, 2025

Add Voting streak multiplier contract #128

Closed

Sara added 3 commits April 24, 2025 10:32

add internal function

4250340

upgradeable contract wont call constructor

9042f17

votingstreakmultiplier is not an erc721 contract

bc484ca

secbajor commented Apr 25, 2025

View reviewed changes

src/YieldDistributor.sol Outdated Show resolved Hide resolved

bagelface requested changes Apr 25, 2025

View reviewed changes

src/YieldDistributor.sol Outdated Show resolved Hide resolved

RonTuretzky requested changes Apr 26, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

Sara added 4 commits April 27, 2025 14:57

Add update function to voting multipliers; remove code from YD

7813141

cleanup and i guess we dont need ivotingstreakmultiplier

9a2a440

f

68f1efc

f

32eab1c

RonTuretzky reviewed Apr 28, 2025

View reviewed changes

src/interfaces/multipliers/IMultiplier.sol Outdated Show resolved Hide resolved

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

Sara added 2 commits April 28, 2025 11:06

add natspec and update mock multiplier

cad7e3d

add no-op updateMultiplierFactor functions

3a761f1

RonTuretzky reviewed Apr 29, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

Sara added 2 commits May 7, 2025 16:34

pass user to updateMultiplyingFactor

7fb1e7e

make compiler happy

b1def3b

RonTuretzky requested changes May 8, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

bagelface and others added 5 commits May 15, 2025 11:11

add basic multiplier streak test

08f183d

rough but passing tests

6babba8

test cleanup

5217f57

remove extra events

1717f2e

f

48508e5

bagelface reviewed May 30, 2025

View reviewed changes

src/interfaces/multipliers/INFTMultiplier.sol Outdated Show resolved Hide resolved

bagelface reviewed May 30, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

bagelface reviewed May 30, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

bagelface reviewed May 30, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

bagelface reviewed May 30, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

bagelface reviewed May 30, 2025

View reviewed changes

test/YieldDistributor.t.sol Outdated Show resolved Hide resolved

bagelface reviewed May 30, 2025

View reviewed changes

test/YieldDistributor.t.sol Outdated Show resolved Hide resolved

bagelface approved these changes May 30, 2025

View reviewed changes

Sara added 4 commits May 31, 2025 14:43

pr review feedback

5d67dc3

total multiplier should start at base 100% ; individual multipliers s…

097e147

…hould be set to fixed point notation small percentages

resolve compiler warning

b1e3882

rename to max multiplier increments

fd16164

secbajor force-pushed the sb-127-2 branch from 5e6023d to fd16164 Compare May 31, 2025 21:54

Sara added 4 commits May 31, 2025 15:03

be clear about what value multiplierIncrement should be

c63332b

make voting boost multipliers like 102%

a41ce0f

all working with separate multiplying factor and multiplier increment

d95dbac

remove separate multiplying factor, use only increment

4961315

secbajor force-pushed the sb-127-2 branch from b9ef00a to 4961315 Compare June 2, 2025 18:45

bagelface reviewed Jun 2, 2025

View reviewed changes

rename function to calculateVotingMultipliers

b6c6182

bagelface reviewed Jun 5, 2025

View reviewed changes

src/interfaces/multipliers/IDynamicNFTMultiplier.sol Show resolved Hide resolved

bagelface reviewed Jun 5, 2025

View reviewed changes

src/multipliers/VotingStreakMultiplier.sol Outdated Show resolved Hide resolved

bagelface reviewed Jun 5, 2025

View reviewed changes

bagelface approved these changes Jun 5, 2025

View reviewed changes

Sara added 2 commits June 5, 2025 17:12

pr review feedback

7e7d15b

move base multiplier to a constants file

f17990d

secbajor merged commit 9a89a95 into dev Jun 6, 2025

		@@ -2,7 +2,11 @@
		pragma solidity ^0.8.0;

		interface IMultiplier {

Implement VotingStreakMultiplier #129

Implement VotingStreakMultiplier #129

Uh oh!

Conversation

secbajor commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

bagelface left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RonTuretzky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

secbajor commented May 8, 2025

Uh oh!

RonTuretzky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bagelface left a comment

Choose a reason for hiding this comment

Uh oh!

bagelface Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

secbajor Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bagelface Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bagelface left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

secbajor commented Apr 24, 2025 •

edited

Loading

bagelface Jun 2, 2025 •

edited

Loading

secbajor Jun 3, 2025 •

edited

Loading

bagelface Jun 5, 2025 •

edited

Loading